<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bluetooth Host Stack Library: GATT Robust Caching</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Bluetooth Host Stack Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__gatt__robust__caching__api__functions.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">GATT Robust Caching<div class="ingroups"><a class="el" href="group__wicedbt__gatt.html">Generic Attribute (GATT)</a> &raquo; <a class="el" href="group__gatt__server__api__functions.html">Server API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>GATT Robust Caching API. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabe091d84b05f98e689d214bfce4b9cef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gatt__robust__caching__api__functions.html#gabe091d84b05f98e689d214bfce4b9cef">wiced_bt_gatt_set_client_supported_features</a> (uint16_t conn_id, <a class="el" href="group__bt__types.html#ga0337d18c240c1a190f5cf7dfb41f529e">wiced_bt_gatt_client_supported_features_t</a> csfs)</td></tr>
<tr class="memdesc:gabe091d84b05f98e689d214bfce4b9cef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the remote client supported features upon write and for bonded device after reconnect as read from NVRAM.  <a href="#gabe091d84b05f98e689d214bfce4b9cef">More...</a><br /></td></tr>
<tr class="separator:gabe091d84b05f98e689d214bfce4b9cef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf11cc1177e1e9f7622ab0c2b555512ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gatt__robust__caching__api__functions.html#gaf11cc1177e1e9f7622ab0c2b555512ab">wiced_bt_gatt_get_client_supported_features</a> (uint16_t conn_id, <a class="el" href="group__bt__types.html#ga0337d18c240c1a190f5cf7dfb41f529e">wiced_bt_gatt_client_supported_features_t</a> csfs)</td></tr>
<tr class="memdesc:gaf11cc1177e1e9f7622ab0c2b555512ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the remote client supported features.  <a href="#gaf11cc1177e1e9f7622ab0c2b555512ab">More...</a><br /></td></tr>
<tr class="separator:gaf11cc1177e1e9f7622ab0c2b555512ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae04af1c4b05f0ceaf2a725513861dbf0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gatt__robust__caching__api__functions.html#gae04af1c4b05f0ceaf2a725513861dbf0">wiced_bt_gatt_get_peer_caching_status</a> (uint16_t conn_id, <a class="el" href="group__wicedbt__gatt.html#ga498a040c6ad01dd19d214d5b64b8a7a2">wiced_bt_gatt_caching_status_t</a> *caching_status)</td></tr>
<tr class="memdesc:gae04af1c4b05f0ceaf2a725513861dbf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function wiced_bt_gatt_get_peer_caching_status Can be used by the server application to read the robust caching status of the peer.  <a href="#gae04af1c4b05f0ceaf2a725513861dbf0">More...</a><br /></td></tr>
<tr class="separator:gae04af1c4b05f0ceaf2a725513861dbf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e608451749237abe23b4382906ede11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gatt__robust__caching__api__functions.html#ga9e608451749237abe23b4382906ede11">wiced_bt_gatt_set_peer_caching_status</a> (uint16_t conn_id, <a class="el" href="group__wicedbt__gatt.html#ga498a040c6ad01dd19d214d5b64b8a7a2">wiced_bt_gatt_caching_status_t</a> status)</td></tr>
<tr class="memdesc:ga9e608451749237abe23b4382906ede11"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used by the application to set peer's caching state.  <a href="#ga9e608451749237abe23b4382906ede11">More...</a><br /></td></tr>
<tr class="separator:ga9e608451749237abe23b4382906ede11"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabe091d84b05f98e689d214bfce4b9cef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe091d84b05f98e689d214bfce4b9cef">&#9670;&nbsp;</a></span>wiced_bt_gatt_set_client_supported_features()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_gatt_set_client_supported_features </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__bt__types.html#ga0337d18c240c1a190f5cf7dfb41f529e">wiced_bt_gatt_client_supported_features_t</a>&#160;</td>
          <td class="paramname"><em>csfs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the remote client supported features upon write and for bonded device after reconnect as read from NVRAM. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>: GATT Connection ID </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">csfs</td><td>: Bit mask as received from the peer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="gaf11cc1177e1e9f7622ab0c2b555512ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf11cc1177e1e9f7622ab0c2b555512ab">&#9670;&nbsp;</a></span>wiced_bt_gatt_get_client_supported_features()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_gatt_get_client_supported_features </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__bt__types.html#ga0337d18c240c1a190f5cf7dfb41f529e">wiced_bt_gatt_client_supported_features_t</a>&#160;</td>
          <td class="paramname"><em>csfs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the remote client supported features. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>: GATT Connection ID </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">csfs</td><td>: Bit mask set in <a class="el" href="group__gatt__robust__caching__api__functions.html#gabe091d84b05f98e689d214bfce4b9cef">wiced_bt_gatt_set_client_supported_features</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="gae04af1c4b05f0ceaf2a725513861dbf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae04af1c4b05f0ceaf2a725513861dbf0">&#9670;&nbsp;</a></span>wiced_bt_gatt_get_peer_caching_status()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_gatt_get_peer_caching_status </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wicedbt__gatt.html#ga498a040c6ad01dd19d214d5b64b8a7a2">wiced_bt_gatt_caching_status_t</a> *&#160;</td>
          <td class="paramname"><em>caching_status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function wiced_bt_gatt_get_peer_caching_status Can be used by the server application to read the robust caching status of the peer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>connection identifier. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">caching_status</td><td>see <a class="el" href="group__wicedbt__gatt.html#ga498a040c6ad01dd19d214d5b64b8a7a2">wiced_bt_gatt_caching_status_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="ga9e608451749237abe23b4382906ede11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9e608451749237abe23b4382906ede11">&#9670;&nbsp;</a></span>wiced_bt_gatt_set_peer_caching_status()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wiced_bt_gatt_set_peer_caching_status </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wicedbt__gatt.html#ga498a040c6ad01dd19d214d5b64b8a7a2">wiced_bt_gatt_caching_status_t</a>&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used by the application to set peer's caching state. </p>
<p>The application is expected to store the last <a class="el" href="group__bt__types.html#ga6b2f6680ad9b818353df2c23bcd96546" title="LE database hash.">wiced_bt_db_hash_t</a> shared with the bonded peer in NVRAM On connection, the application compares the stored <a class="el" href="group__bt__types.html#ga6b2f6680ad9b818353df2c23bcd96546" title="LE database hash.">wiced_bt_db_hash_t</a> with the current db_hash. If the hashes match, the status is set to <a class="el" href="group__wicedbt__gatt.html#gga37752af067adb29bf256c7b130b18ac5a87f80cbd4cca0e10f8fceefa157b5c95" title="Peer client is cache aware.">GATT_PEER_CLIENT_CACHE_CHANGE_AWARE</a> else <a class="el" href="group__wicedbt__gatt.html#gga37752af067adb29bf256c7b130b18ac5a5ba60ac4dac59215913f2c9841f76298" title="Peer client is cache unaware.">GATT_PEER_CLIENT_CACHE_CHANGE_UNAWARE</a></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>connection identifier. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>CHANGE_AWARE/CHANGE_UNAWARE.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Bluetooth Host Stack Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
